Documentation Powered by ReDoc

App Store Connect API (1.2)

Download OpenAPI specification:Download

App Store Connect API Documentation

Authentication

itc-bearer-token

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

AgeRatingDeclarations

ageRatingDeclarations-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AgeRatingDeclaration representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

AppCategories

appCategories-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[platforms]
Array of strings
Items Enum: "IOS" "MAC_OS" "TV_OS"

filter by attribute 'platforms'

exists[parent]
Array of strings

filter by existence or non-existence of related 'parent'

fields[appCategories]
Array of strings
Items Enum: "parent" "platforms" "subcategories"

the fields to include for returned resources of type appCategories

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Enum: "parent" "subcategories"

comma-separated list of relationships to include

limit[subcategories]
integer <= 50

maximum number of related subcategories returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

appCategories-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appCategories]
Array of strings
Items Enum: "parent" "platforms" "subcategories"

the fields to include for returned resources of type appCategories

include
Array of strings
Items Enum: "parent" "subcategories"

comma-separated list of relationships to include

limit[subcategories]
integer <= 50

maximum number of related subcategories returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

AppEncryptionDeclarations

appEncryptionDeclarations-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[platform]
Array of strings
Items Enum: "IOS" "MAC_OS" "TV_OS"

filter by attribute 'platform'

filter[app]
Array of strings

filter by id(s) of related 'app'

filter[builds]
Array of strings

filter by id(s) of related 'builds'

fields[appEncryptionDeclarations]
Array of strings
Items Enum: "app" "appEncryptionDeclarationState" "availableOnFrenchStore" "builds" "codeValue" "containsProprietaryCryptography" "containsThirdPartyCryptography" "documentName" "documentType" "documentUrl" "exempt" "platform" "uploadedDate" "usesEncryption"

the fields to include for returned resources of type appEncryptionDeclarations

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Value: "app"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

appEncryptionDeclarations-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appEncryptionDeclarations]
Array of strings
Items Enum: "app" "appEncryptionDeclarationState" "availableOnFrenchStore" "builds" "codeValue" "containsProprietaryCryptography" "containsThirdPartyCryptography" "documentName" "documentType" "documentUrl" "exempt" "platform" "uploadedDate" "usesEncryption"

the fields to include for returned resources of type appEncryptionDeclarations

include
Array of strings
Items Value: "app"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appEncryptionDeclarations-builds-create_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppInfoLocalizations

appInfoLocalizations-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppInfoLocalization representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appInfoLocalizations-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appInfoLocalizations]
Array of strings
Items Enum: "appInfo" "locale" "name" "privacyPolicyText" "privacyPolicyUrl" "subtitle"

the fields to include for returned resources of type appInfoLocalizations

include
Array of strings
Items Value: "appInfo"

comma-separated list of relationships to include

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appInfoLocalizations-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AppInfoLocalization representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appInfoLocalizations-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppInfos

appInfos-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appInfos]
Array of strings
Items Enum: "app" "appInfoLocalizations" "appStoreAgeRating" "appStoreState" "brazilAgeRating" "kidsAgeBand" "primaryCategory" "primarySubcategoryOne" "primarySubcategoryTwo" "secondaryCategory" "secondarySubcategoryOne" "secondarySubcategoryTwo"

the fields to include for returned resources of type appInfos

include
Array of strings
Items Enum: "app" "appInfoLocalizations" "primaryCategory" "primarySubcategoryOne" "primarySubcategoryTwo" "secondaryCategory" "secondarySubcategoryOne" "secondarySubcategoryTwo"

comma-separated list of relationships to include

fields[appCategories]
Array of strings
Items Enum: "parent" "platforms" "subcategories"

the fields to include for returned resources of type appCategories

fields[appInfoLocalizations]
Array of strings
Items Enum: "appInfo" "locale" "name" "privacyPolicyText" "privacyPolicyUrl" "subtitle"

the fields to include for returned resources of type appInfoLocalizations

limit[appInfoLocalizations]
integer <= 50

maximum number of related appInfoLocalizations returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appInfos-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AppInfo representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

AppPreOrders

appPreOrders-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppPreOrder representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appPreOrders-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appPreOrders]
Array of strings
Items Enum: "app" "appReleaseDate" "preOrderAvailableDate"

the fields to include for returned resources of type appPreOrders

include
Array of strings
Items Value: "app"

comma-separated list of relationships to include

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appPreOrders-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AppPreOrder representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appPreOrders-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppPreviewSets

appPreviewSets-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppPreviewSet representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appPreviewSets-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appPreviewSets]
Array of strings
Items Enum: "appPreviews" "appStoreVersionLocalization" "previewType"

the fields to include for returned resources of type appPreviewSets

include
Array of strings
Items Enum: "appPreviews" "appStoreVersionLocalization"

comma-separated list of relationships to include

fields[appPreviews]
Array of strings
Items Enum: "appPreviewSet" "assetDeliveryState" "fileName" "fileSize" "mimeType" "previewFrameTimeCode" "previewImage" "sourceFileChecksum" "uploadOperations" "uploaded" "videoUrl"

the fields to include for returned resources of type appPreviews

limit[appPreviews]
integer <= 50

maximum number of related appPreviews returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appPreviewSets-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

appPreviewSets-appPreviews-get_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

appPreviewSets-appPreviews-replace_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppPreviews

appPreviews-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppPreview representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appPreviews-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appPreviews]
Array of strings
Items Enum: "appPreviewSet" "assetDeliveryState" "fileName" "fileSize" "mimeType" "previewFrameTimeCode" "previewImage" "sourceFileChecksum" "uploadOperations" "uploaded" "videoUrl"

the fields to include for returned resources of type appPreviews

include
Array of strings
Items Value: "appPreviewSet"

comma-separated list of relationships to include

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appPreviews-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AppPreview representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appPreviews-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppPricePoints

appPricePoints-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[priceTier]
Array of strings

filter by id(s) of related 'priceTier'

filter[territory]
Array of strings

filter by id(s) of related 'territory'

fields[appPricePoints]
Array of strings
Items Enum: "customerPrice" "priceTier" "proceeds" "territory"

the fields to include for returned resources of type appPricePoints

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Enum: "priceTier" "territory"

comma-separated list of relationships to include

fields[territories]
Array of strings
Items Value: "currency"

the fields to include for returned resources of type territories

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

appPricePoints-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appPricePoints]
Array of strings
Items Enum: "customerPrice" "priceTier" "proceeds" "territory"

the fields to include for returned resources of type appPricePoints

include
Array of strings
Items Enum: "priceTier" "territory"

comma-separated list of relationships to include

fields[territories]
Array of strings
Items Value: "currency"

the fields to include for returned resources of type territories

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

AppPriceTiers

appPriceTiers-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[id]
Array of strings

filter by id(s)

fields[appPriceTiers]
Array of strings
Items Value: "pricePoints"

the fields to include for returned resources of type appPriceTiers

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Value: "pricePoints"

comma-separated list of relationships to include

fields[appPricePoints]
Array of strings
Items Enum: "customerPrice" "priceTier" "proceeds" "territory"

the fields to include for returned resources of type appPricePoints

limit[pricePoints]
integer <= 50

maximum number of related pricePoints returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

appPriceTiers-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appPriceTiers]
Array of strings
Items Value: "pricePoints"

the fields to include for returned resources of type appPriceTiers

include
Array of strings
Items Value: "pricePoints"

comma-separated list of relationships to include

fields[appPricePoints]
Array of strings
Items Enum: "customerPrice" "priceTier" "proceeds" "territory"

the fields to include for returned resources of type appPricePoints

limit[pricePoints]
integer <= 50

maximum number of related pricePoints returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

AppPrices

appPrices-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appPrices]
Array of strings
Items Enum: "app" "priceTier"

the fields to include for returned resources of type appPrices

include
Array of strings
Items Enum: "app" "priceTier"

comma-separated list of relationships to include

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

AppScreenshotSets

appScreenshotSets-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppScreenshotSet representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appScreenshotSets-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appScreenshotSets]
Array of strings
Items Enum: "appScreenshots" "appStoreVersionLocalization" "screenshotDisplayType"

the fields to include for returned resources of type appScreenshotSets

include
Array of strings
Items Enum: "appScreenshots" "appStoreVersionLocalization"

comma-separated list of relationships to include

fields[appScreenshots]
Array of strings
Items Enum: "appScreenshotSet" "assetDeliveryState" "assetToken" "assetType" "fileName" "fileSize" "imageAsset" "sourceFileChecksum" "uploadOperations" "uploaded"

the fields to include for returned resources of type appScreenshots

limit[appScreenshots]
integer <= 50

maximum number of related appScreenshots returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appScreenshotSets-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

appScreenshotSets-appScreenshots-get_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

appScreenshotSets-appScreenshots-replace_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppScreenshots

appScreenshots-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppScreenshot representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appScreenshots-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appScreenshots]
Array of strings
Items Enum: "appScreenshotSet" "assetDeliveryState" "assetToken" "assetType" "fileName" "fileSize" "imageAsset" "sourceFileChecksum" "uploadOperations" "uploaded"

the fields to include for returned resources of type appScreenshots

include
Array of strings
Items Value: "appScreenshotSet"

comma-separated list of relationships to include

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appScreenshots-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AppScreenshot representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appScreenshots-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppStoreReviewAttachments

appStoreReviewAttachments-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppStoreReviewAttachment representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appStoreReviewAttachments-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appStoreReviewAttachments]
Array of strings
Items Enum: "appStoreReviewDetail" "assetDeliveryState" "fileName" "fileSize" "sourceFileChecksum" "uploadOperations" "uploaded"

the fields to include for returned resources of type appStoreReviewAttachments

include
Array of strings
Items Value: "appStoreReviewDetail"

comma-separated list of relationships to include

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appStoreReviewAttachments-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AppStoreReviewAttachment representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appStoreReviewAttachments-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppStoreReviewDetails

appStoreReviewDetails-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppStoreReviewDetail representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appStoreReviewDetails-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appStoreReviewDetails]
Array of strings
Items Enum: "appStoreReviewAttachments" "appStoreVersion" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes"

the fields to include for returned resources of type appStoreReviewDetails

include
Array of strings
Items Enum: "appStoreReviewAttachments" "appStoreVersion"

comma-separated list of relationships to include

fields[appStoreReviewAttachments]
Array of strings
Items Enum: "appStoreReviewDetail" "assetDeliveryState" "fileName" "fileSize" "sourceFileChecksum" "uploadOperations" "uploaded"

the fields to include for returned resources of type appStoreReviewAttachments

limit[appStoreReviewAttachments]
integer <= 50

maximum number of related appStoreReviewAttachments returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appStoreReviewDetails-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AppStoreReviewDetail representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

AppStoreVersionLocalizations

appStoreVersionLocalizations-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppStoreVersionLocalization representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appStoreVersionLocalizations-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appStoreVersionLocalizations]
Array of strings
Items Enum: "appPreviewSets" "appScreenshotSets" "appStoreVersion" "description" "keywords" "locale" "marketingUrl" "promotionalText" "supportUrl" "whatsNew"

the fields to include for returned resources of type appStoreVersionLocalizations

include
Array of strings
Items Enum: "appPreviewSets" "appScreenshotSets" "appStoreVersion"

comma-separated list of relationships to include

fields[appScreenshotSets]
Array of strings
Items Enum: "appScreenshots" "appStoreVersionLocalization" "screenshotDisplayType"

the fields to include for returned resources of type appScreenshotSets

fields[appPreviewSets]
Array of strings
Items Enum: "appPreviews" "appStoreVersionLocalization" "previewType"

the fields to include for returned resources of type appPreviewSets

limit[appPreviewSets]
integer <= 50

maximum number of related appPreviewSets returned (when they are included)

limit[appScreenshotSets]
integer <= 50

maximum number of related appScreenshotSets returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appStoreVersionLocalizations-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AppStoreVersionLocalization representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appStoreVersionLocalizations-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppStoreVersionPhasedReleases

appStoreVersionPhasedReleases-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppStoreVersionPhasedRelease representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appStoreVersionPhasedReleases-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AppStoreVersionPhasedRelease representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appStoreVersionPhasedReleases-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppStoreVersionSubmissions

appStoreVersionSubmissions-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppStoreVersionSubmission representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appStoreVersionSubmissions-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

AppStoreVersions

appStoreVersions-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

AppStoreVersion representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appStoreVersions-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[appStoreVersions]
Array of strings
Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreState" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "copyright" "createdDate" "downloadable" "earliestReleaseDate" "idfaDeclaration" "platform" "releaseType" "routingAppCoverage" "usesIdfa" "versionString"

the fields to include for returned resources of type appStoreVersions

include
Array of strings
Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "idfaDeclaration" "routingAppCoverage"

comma-separated list of relationships to include

fields[appStoreVersionLocalizations]
Array of strings
Items Enum: "appPreviewSets" "appScreenshotSets" "appStoreVersion" "description" "keywords" "locale" "marketingUrl" "promotionalText" "supportUrl" "whatsNew"

the fields to include for returned resources of type appStoreVersionLocalizations

fields[idfaDeclarations]
Array of strings
Items Enum: "appStoreVersion" "attributesActionWithPreviousAd" "attributesAppInstallationToPreviousAd" "honorsLimitedAdTracking" "servesAds"

the fields to include for returned resources of type idfaDeclarations

fields[routingAppCoverages]
Array of strings
Items Enum: "appStoreVersion" "assetDeliveryState" "fileName" "fileSize" "sourceFileChecksum" "uploadOperations" "uploaded"

the fields to include for returned resources of type routingAppCoverages

fields[appStoreVersionPhasedReleases]
Array of strings
Items Enum: "appStoreVersion" "currentDayNumber" "phasedReleaseState" "startDate" "totalPauseDuration"

the fields to include for returned resources of type appStoreVersionPhasedReleases

fields[ageRatingDeclarations]
Array of strings
Items Enum: "alcoholTobaccoOrDrugUseOrReferences" "gamblingAndContests" "gamblingSimulated" "horrorOrFearThemes" "kidsAgeBand" "matureOrSuggestiveThemes" "medicalOrTreatmentInformation" "profanityOrCrudeHumor" "sexualContentGraphicAndNudity" "sexualContentOrNudity" "unrestrictedWebAccess" "violenceCartoonOrFantasy" "violenceRealistic" "violenceRealisticProlongedGraphicOrSadistic"

the fields to include for returned resources of type ageRatingDeclarations

fields[appStoreReviewDetails]
Array of strings
Items Enum: "appStoreReviewAttachments" "appStoreVersion" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes"

the fields to include for returned resources of type appStoreReviewDetails

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

fields[appStoreVersionSubmissions]
Array of strings
Items Value: "appStoreVersion"

the fields to include for returned resources of type appStoreVersionSubmissions

limit[appStoreVersionLocalizations]
integer <= 50

maximum number of related appStoreVersionLocalizations returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appStoreVersions-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

AppStoreVersion representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

appStoreVersions-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

appStoreVersions-build-get_to_one_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

appStoreVersions-build-update_to_one_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

Related linkage

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

Apps

apps-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[appStoreVersions.appStoreState]
Array of strings
Items Enum: "DEVELOPER_REMOVED_FROM_SALE" "DEVELOPER_REJECTED" "IN_REVIEW" "INVALID_BINARY" "METADATA_REJECTED" "PENDING_APPLE_RELEASE" "PENDING_CONTRACT" "PENDING_DEVELOPER_RELEASE" "PREPARE_FOR_SUBMISSION" "PREORDER_READY_FOR_SALE" "PROCESSING_FOR_APP_STORE" "READY_FOR_SALE" "REJECTED" "REMOVED_FROM_SALE" "WAITING_FOR_EXPORT_COMPLIANCE" "WAITING_FOR_REVIEW" "REPLACED_WITH_NEW_VERSION"

filter by attribute 'appStoreVersions.appStoreState'

filter[appStoreVersions.platform]
Array of strings
Items Enum: "IOS" "MAC_OS" "TV_OS"

filter by attribute 'appStoreVersions.platform'

filter[bundleId]
Array of strings

filter by attribute 'bundleId'

filter[name]
Array of strings

filter by attribute 'name'

filter[sku]
Array of strings

filter by attribute 'sku'

filter[appStoreVersions]
Array of strings

filter by id(s) of related 'appStoreVersions'

filter[id]
Array of strings

filter by id(s)

exists[gameCenterEnabledVersions]
Array of strings

filter by existence or non-existence of related 'gameCenterEnabledVersions'

sort
Array of strings
Items Enum: "bundleId" "-bundleId" "name" "-name" "sku" "-sku"

comma-separated list of sort expressions; resources will be sorted as specified

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "builds" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "preOrder" "preReleaseVersions" "prices"

comma-separated list of relationships to include

fields[betaGroups]
Array of strings
Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled"

the fields to include for returned resources of type betaGroups

fields[perfPowerMetrics]
Array of strings
Items Enum: "deviceType" "metricType" "platform"

the fields to include for returned resources of type perfPowerMetrics

fields[appInfos]
Array of strings
Items Enum: "app" "appInfoLocalizations" "appStoreAgeRating" "appStoreState" "brazilAgeRating" "kidsAgeBand" "primaryCategory" "primarySubcategoryOne" "primarySubcategoryTwo" "secondaryCategory" "secondarySubcategoryOne" "secondarySubcategoryTwo"

the fields to include for returned resources of type appInfos

fields[appPreOrders]
Array of strings
Items Enum: "app" "appReleaseDate" "preOrderAvailableDate"

the fields to include for returned resources of type appPreOrders

fields[preReleaseVersions]
Array of strings
Items Enum: "app" "builds" "platform" "version"

the fields to include for returned resources of type preReleaseVersions

fields[appPrices]
Array of strings
Items Enum: "app" "priceTier"

the fields to include for returned resources of type appPrices

fields[inAppPurchases]
Array of strings
Items Enum: "apps" "inAppPurchaseType" "productId" "referenceName" "state"

the fields to include for returned resources of type inAppPurchases

fields[betaAppReviewDetails]
Array of strings
Items Enum: "app" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes"

the fields to include for returned resources of type betaAppReviewDetails

fields[territories]
Array of strings
Items Value: "currency"

the fields to include for returned resources of type territories

fields[gameCenterEnabledVersions]
Array of strings
Items Enum: "app" "compatibleVersions" "iconAsset" "platform" "versionString"

the fields to include for returned resources of type gameCenterEnabledVersions

fields[appStoreVersions]
Array of strings
Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreState" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "copyright" "createdDate" "downloadable" "earliestReleaseDate" "idfaDeclaration" "platform" "releaseType" "routingAppCoverage" "usesIdfa" "versionString"

the fields to include for returned resources of type appStoreVersions

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

fields[betaAppLocalizations]
Array of strings
Items Enum: "app" "description" "feedbackEmail" "locale" "marketingUrl" "privacyPolicyUrl" "tvOsPrivacyPolicy"

the fields to include for returned resources of type betaAppLocalizations

fields[betaLicenseAgreements]
Array of strings
Items Enum: "agreementText" "app"

the fields to include for returned resources of type betaLicenseAgreements

fields[endUserLicenseAgreements]
Array of strings
Items Enum: "agreementText" "app" "territories"

the fields to include for returned resources of type endUserLicenseAgreements

limit[appInfos]
integer <= 50

maximum number of related appInfos returned (when they are included)

limit[appStoreVersions]
integer <= 50

maximum number of related appStoreVersions returned (when they are included)

limit[availableTerritories]
integer <= 50

maximum number of related availableTerritories returned (when they are included)

limit[betaAppLocalizations]
integer <= 50

maximum number of related betaAppLocalizations returned (when they are included)

limit[betaGroups]
integer <= 50

maximum number of related betaGroups returned (when they are included)

limit[builds]
integer <= 50

maximum number of related builds returned (when they are included)

limit[gameCenterEnabledVersions]
integer <= 50

maximum number of related gameCenterEnabledVersions returned (when they are included)

limit[inAppPurchases]
integer <= 50

maximum number of related inAppPurchases returned (when they are included)

limit[preReleaseVersions]
integer <= 50

maximum number of related preReleaseVersions returned (when they are included)

limit[prices]
integer <= 50

maximum number of related prices returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

apps-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

include
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "builds" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "preOrder" "preReleaseVersions" "prices"

comma-separated list of relationships to include

fields[betaGroups]
Array of strings
Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled"

the fields to include for returned resources of type betaGroups

fields[perfPowerMetrics]
Array of strings
Items Enum: "deviceType" "metricType" "platform"

the fields to include for returned resources of type perfPowerMetrics

fields[appInfos]
Array of strings
Items Enum: "app" "appInfoLocalizations" "appStoreAgeRating" "appStoreState" "brazilAgeRating" "kidsAgeBand" "primaryCategory" "primarySubcategoryOne" "primarySubcategoryTwo" "secondaryCategory" "secondarySubcategoryOne" "secondarySubcategoryTwo"

the fields to include for returned resources of type appInfos

fields[appPreOrders]
Array of strings
Items Enum: "app" "appReleaseDate" "preOrderAvailableDate"

the fields to include for returned resources of type appPreOrders

fields[preReleaseVersions]
Array of strings
Items Enum: "app" "builds" "platform" "version"

the fields to include for returned resources of type preReleaseVersions

fields[appPrices]
Array of strings
Items Enum: "app" "priceTier"

the fields to include for returned resources of type appPrices

fields[inAppPurchases]
Array of strings
Items Enum: "apps" "inAppPurchaseType" "productId" "referenceName" "state"

the fields to include for returned resources of type inAppPurchases

fields[betaAppReviewDetails]
Array of strings
Items Enum: "app" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes"

the fields to include for returned resources of type betaAppReviewDetails

fields[territories]
Array of strings
Items Value: "currency"

the fields to include for returned resources of type territories

fields[gameCenterEnabledVersions]
Array of strings
Items Enum: "app" "compatibleVersions" "iconAsset" "platform" "versionString"

the fields to include for returned resources of type gameCenterEnabledVersions

fields[appStoreVersions]
Array of strings
Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreState" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "copyright" "createdDate" "downloadable" "earliestReleaseDate" "idfaDeclaration" "platform" "releaseType" "routingAppCoverage" "usesIdfa" "versionString"

the fields to include for returned resources of type appStoreVersions

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

fields[betaAppLocalizations]
Array of strings
Items Enum: "app" "description" "feedbackEmail" "locale" "marketingUrl" "privacyPolicyUrl" "tvOsPrivacyPolicy"

the fields to include for returned resources of type betaAppLocalizations

fields[betaLicenseAgreements]
Array of strings
Items Enum: "agreementText" "app"

the fields to include for returned resources of type betaLicenseAgreements

fields[endUserLicenseAgreements]
Array of strings
Items Enum: "agreementText" "app" "territories"

the fields to include for returned resources of type endUserLicenseAgreements

limit[appInfos]
integer <= 50

maximum number of related appInfos returned (when they are included)

limit[appStoreVersions]
integer <= 50

maximum number of related appStoreVersions returned (when they are included)

limit[availableTerritories]
integer <= 50

maximum number of related availableTerritories returned (when they are included)

limit[betaAppLocalizations]
integer <= 50

maximum number of related betaAppLocalizations returned (when they are included)

limit[betaGroups]
integer <= 50

maximum number of related betaGroups returned (when they are included)

limit[builds]
integer <= 50

maximum number of related builds returned (when they are included)

limit[gameCenterEnabledVersions]
integer <= 50

maximum number of related gameCenterEnabledVersions returned (when they are included)

limit[inAppPurchases]
integer <= 50

maximum number of related inAppPurchases returned (when they are included)

limit[preReleaseVersions]
integer <= 50

maximum number of related preReleaseVersions returned (when they are included)

limit[prices]
integer <= 50

maximum number of related prices returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

apps-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

App representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

apps-betaTesters-delete_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

BetaAppLocalizations

betaAppLocalizations-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[locale]
Array of strings

filter by attribute 'locale'

filter[app]
Array of strings

filter by id(s) of related 'app'

fields[betaAppLocalizations]
Array of strings
Items Enum: "app" "description" "feedbackEmail" "locale" "marketingUrl" "privacyPolicyUrl" "tvOsPrivacyPolicy"

the fields to include for returned resources of type betaAppLocalizations

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Value: "app"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaAppLocalizations-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

BetaAppLocalization representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaAppLocalizations-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[betaAppLocalizations]
Array of strings
Items Enum: "app" "description" "feedbackEmail" "locale" "marketingUrl" "privacyPolicyUrl" "tvOsPrivacyPolicy"

the fields to include for returned resources of type betaAppLocalizations

include
Array of strings
Items Value: "app"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaAppLocalizations-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

BetaAppLocalization representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaAppLocalizations-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

BetaAppReviewDetails

betaAppReviewDetails-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[app]
required
Array of strings

filter by id(s) of related 'app'

fields[betaAppReviewDetails]
Array of strings
Items Enum: "app" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes"

the fields to include for returned resources of type betaAppReviewDetails

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Value: "app"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaAppReviewDetails-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[betaAppReviewDetails]
Array of strings
Items Enum: "app" "contactEmail" "contactFirstName" "contactLastName" "contactPhone" "demoAccountName" "demoAccountPassword" "demoAccountRequired" "notes"

the fields to include for returned resources of type betaAppReviewDetails

include
Array of strings
Items Value: "app"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaAppReviewDetails-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

BetaAppReviewDetail representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

BetaAppReviewSubmissions

betaAppReviewSubmissions-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[betaReviewState]
Array of strings
Items Enum: "WAITING_FOR_REVIEW" "IN_REVIEW" "REJECTED" "APPROVED"

filter by attribute 'betaReviewState'

filter[build]
required
Array of strings

filter by id(s) of related 'build'

fields[betaAppReviewSubmissions]
Array of strings
Items Enum: "betaReviewState" "build"

the fields to include for returned resources of type betaAppReviewSubmissions

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Value: "build"

comma-separated list of relationships to include

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaAppReviewSubmissions-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

BetaAppReviewSubmission representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaAppReviewSubmissions-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[betaAppReviewSubmissions]
Array of strings
Items Enum: "betaReviewState" "build"

the fields to include for returned resources of type betaAppReviewSubmissions

include
Array of strings
Items Value: "build"

comma-separated list of relationships to include

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

BetaBuildLocalizations

betaBuildLocalizations-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[locale]
Array of strings

filter by attribute 'locale'

filter[build]
Array of strings

filter by id(s) of related 'build'

fields[betaBuildLocalizations]
Array of strings
Items Enum: "build" "locale" "whatsNew"

the fields to include for returned resources of type betaBuildLocalizations

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Value: "build"

comma-separated list of relationships to include

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaBuildLocalizations-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

BetaBuildLocalization representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaBuildLocalizations-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[betaBuildLocalizations]
Array of strings
Items Enum: "build" "locale" "whatsNew"

the fields to include for returned resources of type betaBuildLocalizations

include
Array of strings
Items Value: "build"

comma-separated list of relationships to include

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaBuildLocalizations-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

BetaBuildLocalization representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaBuildLocalizations-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

BetaGroups

betaGroups-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[isInternalGroup]
Array of strings

filter by attribute 'isInternalGroup'

filter[name]
Array of strings

filter by attribute 'name'

filter[publicLink]
Array of strings

filter by attribute 'publicLink'

filter[publicLinkEnabled]
Array of strings

filter by attribute 'publicLinkEnabled'

filter[publicLinkLimitEnabled]
Array of strings

filter by attribute 'publicLinkLimitEnabled'

filter[app]
Array of strings

filter by id(s) of related 'app'

filter[builds]
Array of strings

filter by id(s) of related 'builds'

filter[id]
Array of strings

filter by id(s)

sort
Array of strings
Items Enum: "createdDate" "-createdDate" "name" "-name" "publicLinkEnabled" "-publicLinkEnabled" "publicLinkLimit" "-publicLinkLimit"

comma-separated list of sort expressions; resources will be sorted as specified

fields[betaGroups]
Array of strings
Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled"

the fields to include for returned resources of type betaGroups

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Enum: "app" "betaTesters" "builds"

comma-separated list of relationships to include

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

fields[betaTesters]
Array of strings
Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName"

the fields to include for returned resources of type betaTesters

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[betaTesters]
integer <= 50

maximum number of related betaTesters returned (when they are included)

limit[builds]
integer <= 1000

maximum number of related builds returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaGroups-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

BetaGroup representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaGroups-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[betaGroups]
Array of strings
Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled"

the fields to include for returned resources of type betaGroups

include
Array of strings
Items Enum: "app" "betaTesters" "builds"

comma-separated list of relationships to include

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

fields[betaTesters]
Array of strings
Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName"

the fields to include for returned resources of type betaTesters

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[betaTesters]
integer <= 50

maximum number of related betaTesters returned (when they are included)

limit[builds]
integer <= 1000

maximum number of related builds returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaGroups-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

BetaGroup representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaGroups-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

betaGroups-betaTesters-get_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaGroups-betaTesters-create_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

betaGroups-betaTesters-delete_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

betaGroups-builds-get_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaGroups-builds-create_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

betaGroups-builds-delete_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

BetaLicenseAgreements

betaLicenseAgreements-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[app]
Array of strings

filter by id(s) of related 'app'

fields[betaLicenseAgreements]
Array of strings
Items Enum: "agreementText" "app"

the fields to include for returned resources of type betaLicenseAgreements

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Value: "app"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaLicenseAgreements-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[betaLicenseAgreements]
Array of strings
Items Enum: "agreementText" "app"

the fields to include for returned resources of type betaLicenseAgreements

include
Array of strings
Items Value: "app"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaLicenseAgreements-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

BetaLicenseAgreement representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

BetaTesterInvitations

betaTesterInvitations-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

BetaTesterInvitation representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

BetaTesters

betaTesters-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[email]
Array of strings

filter by attribute 'email'

filter[firstName]
Array of strings

filter by attribute 'firstName'

filter[inviteType]
Array of strings
Items Enum: "EMAIL" "PUBLIC_LINK"

filter by attribute 'inviteType'

filter[lastName]
Array of strings

filter by attribute 'lastName'

filter[apps]
Array of strings

filter by id(s) of related 'apps'

filter[betaGroups]
Array of strings

filter by id(s) of related 'betaGroups'

filter[builds]
Array of strings

filter by id(s) of related 'builds'

sort
Array of strings
Items Enum: "email" "-email" "firstName" "-firstName" "inviteType" "-inviteType" "lastName" "-lastName"

comma-separated list of sort expressions; resources will be sorted as specified

fields[betaTesters]
Array of strings
Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName"

the fields to include for returned resources of type betaTesters

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Enum: "apps" "betaGroups" "builds"

comma-separated list of relationships to include

fields[betaGroups]
Array of strings
Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled"

the fields to include for returned resources of type betaGroups

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[apps]
integer <= 50

maximum number of related apps returned (when they are included)

limit[betaGroups]
integer <= 50

maximum number of related betaGroups returned (when they are included)

limit[builds]
integer <= 50

maximum number of related builds returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaTesters-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

BetaTester representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaTesters-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[betaTesters]
Array of strings
Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName"

the fields to include for returned resources of type betaTesters

include
Array of strings
Items Enum: "apps" "betaGroups" "builds"

comma-separated list of relationships to include

fields[betaGroups]
Array of strings
Items Enum: "app" "betaTesters" "builds" "createdDate" "feedbackEnabled" "isInternalGroup" "name" "publicLink" "publicLinkEnabled" "publicLinkId" "publicLinkLimit" "publicLinkLimitEnabled"

the fields to include for returned resources of type betaGroups

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[apps]
integer <= 50

maximum number of related apps returned (when they are included)

limit[betaGroups]
integer <= 50

maximum number of related betaGroups returned (when they are included)

limit[builds]
integer <= 50

maximum number of related builds returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

betaTesters-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

betaTesters-apps-get_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaTesters-apps-delete_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

betaTesters-betaGroups-get_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaTesters-betaGroups-create_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

betaTesters-betaGroups-delete_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

betaTesters-builds-get_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

betaTesters-builds-create_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

betaTesters-builds-delete_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

BuildBetaDetails

buildBetaDetails-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[build]
Array of strings

filter by id(s) of related 'build'

filter[id]
Array of strings

filter by id(s)

fields[buildBetaDetails]
Array of strings
Items Enum: "autoNotifyEnabled" "build" "externalBuildState" "internalBuildState"

the fields to include for returned resources of type buildBetaDetails

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Value: "build"

comma-separated list of relationships to include

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

buildBetaDetails-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[buildBetaDetails]
Array of strings
Items Enum: "autoNotifyEnabled" "build" "externalBuildState" "internalBuildState"

the fields to include for returned resources of type buildBetaDetails

include
Array of strings
Items Value: "build"

comma-separated list of relationships to include

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

buildBetaDetails-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

BuildBetaDetail representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

BuildBetaNotifications

buildBetaNotifications-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

BuildBetaNotification representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

Builds

builds-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[betaAppReviewSubmission.betaReviewState]
Array of strings
Items Enum: "WAITING_FOR_REVIEW" "IN_REVIEW" "REJECTED" "APPROVED"

filter by attribute 'betaAppReviewSubmission.betaReviewState'

filter[expired]
Array of strings

filter by attribute 'expired'

filter[preReleaseVersion.platform]
Array of strings
Items Enum: "IOS" "MAC_OS" "TV_OS"

filter by attribute 'preReleaseVersion.platform'

filter[preReleaseVersion.version]
Array of strings

filter by attribute 'preReleaseVersion.version'

filter[processingState]
Array of strings
Items Enum: "PROCESSING" "FAILED" "INVALID" "VALID"

filter by attribute 'processingState'

filter[usesNonExemptEncryption]
Array of strings

filter by attribute 'usesNonExemptEncryption'

filter[version]
Array of strings

filter by attribute 'version'

filter[app]
Array of strings

filter by id(s) of related 'app'

filter[appStoreVersion]
Array of strings

filter by id(s) of related 'appStoreVersion'

filter[betaGroups]
Array of strings

filter by id(s) of related 'betaGroups'

filter[preReleaseVersion]
Array of strings

filter by id(s) of related 'preReleaseVersion'

filter[id]
Array of strings

filter by id(s)

sort
Array of strings
Items Enum: "preReleaseVersion" "-preReleaseVersion" "uploadedDate" "-uploadedDate" "version" "-version"

comma-separated list of sort expressions; resources will be sorted as specified

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "buildBetaDetail" "icons" "individualTesters" "preReleaseVersion"

comma-separated list of relationships to include

fields[appEncryptionDeclarations]
Array of strings
Items Enum: "app" "appEncryptionDeclarationState" "availableOnFrenchStore" "builds" "codeValue" "containsProprietaryCryptography" "containsThirdPartyCryptography" "documentName" "documentType" "documentUrl" "exempt" "platform" "uploadedDate" "usesEncryption"

the fields to include for returned resources of type appEncryptionDeclarations

fields[betaAppReviewSubmissions]
Array of strings
Items Enum: "betaReviewState" "build"

the fields to include for returned resources of type betaAppReviewSubmissions

fields[buildBetaDetails]
Array of strings
Items Enum: "autoNotifyEnabled" "build" "externalBuildState" "internalBuildState"

the fields to include for returned resources of type buildBetaDetails

fields[buildIcons]
Array of strings
Items Enum: "iconAsset" "iconType"

the fields to include for returned resources of type buildIcons

fields[perfPowerMetrics]
Array of strings
Items Enum: "deviceType" "metricType" "platform"

the fields to include for returned resources of type perfPowerMetrics

fields[preReleaseVersions]
Array of strings
Items Enum: "app" "builds" "platform" "version"

the fields to include for returned resources of type preReleaseVersions

fields[appStoreVersions]
Array of strings
Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreState" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "copyright" "createdDate" "downloadable" "earliestReleaseDate" "idfaDeclaration" "platform" "releaseType" "routingAppCoverage" "usesIdfa" "versionString"

the fields to include for returned resources of type appStoreVersions

fields[diagnosticSignatures]
Array of strings
Items Enum: "diagnosticType" "logs" "signature" "weight"

the fields to include for returned resources of type diagnosticSignatures

fields[betaTesters]
Array of strings
Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName"

the fields to include for returned resources of type betaTesters

fields[betaBuildLocalizations]
Array of strings
Items Enum: "build" "locale" "whatsNew"

the fields to include for returned resources of type betaBuildLocalizations

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[betaBuildLocalizations]
integer <= 50

maximum number of related betaBuildLocalizations returned (when they are included)

limit[icons]
integer <= 50

maximum number of related icons returned (when they are included)

limit[individualTesters]
integer <= 50

maximum number of related individualTesters returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

builds-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

include
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "buildBetaDetail" "icons" "individualTesters" "preReleaseVersion"

comma-separated list of relationships to include

fields[appEncryptionDeclarations]
Array of strings
Items Enum: "app" "appEncryptionDeclarationState" "availableOnFrenchStore" "builds" "codeValue" "containsProprietaryCryptography" "containsThirdPartyCryptography" "documentName" "documentType" "documentUrl" "exempt" "platform" "uploadedDate" "usesEncryption"

the fields to include for returned resources of type appEncryptionDeclarations

fields[betaAppReviewSubmissions]
Array of strings
Items Enum: "betaReviewState" "build"

the fields to include for returned resources of type betaAppReviewSubmissions

fields[buildBetaDetails]
Array of strings
Items Enum: "autoNotifyEnabled" "build" "externalBuildState" "internalBuildState"

the fields to include for returned resources of type buildBetaDetails

fields[buildIcons]
Array of strings
Items Enum: "iconAsset" "iconType"

the fields to include for returned resources of type buildIcons

fields[perfPowerMetrics]
Array of strings
Items Enum: "deviceType" "metricType" "platform"

the fields to include for returned resources of type perfPowerMetrics

fields[preReleaseVersions]
Array of strings
Items Enum: "app" "builds" "platform" "version"

the fields to include for returned resources of type preReleaseVersions

fields[appStoreVersions]
Array of strings
Items Enum: "ageRatingDeclaration" "app" "appStoreReviewDetail" "appStoreState" "appStoreVersionLocalizations" "appStoreVersionPhasedRelease" "appStoreVersionSubmission" "build" "copyright" "createdDate" "downloadable" "earliestReleaseDate" "idfaDeclaration" "platform" "releaseType" "routingAppCoverage" "usesIdfa" "versionString"

the fields to include for returned resources of type appStoreVersions

fields[diagnosticSignatures]
Array of strings
Items Enum: "diagnosticType" "logs" "signature" "weight"

the fields to include for returned resources of type diagnosticSignatures

fields[betaTesters]
Array of strings
Items Enum: "apps" "betaGroups" "builds" "email" "firstName" "inviteType" "lastName"

the fields to include for returned resources of type betaTesters

fields[betaBuildLocalizations]
Array of strings
Items Enum: "build" "locale" "whatsNew"

the fields to include for returned resources of type betaBuildLocalizations

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[betaBuildLocalizations]
integer <= 50

maximum number of related betaBuildLocalizations returned (when they are included)

limit[icons]
integer <= 50

maximum number of related icons returned (when they are included)

limit[individualTesters]
integer <= 50

maximum number of related individualTesters returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

builds-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

Build representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

builds-appEncryptionDeclaration-get_to_one_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

builds-appEncryptionDeclaration-update_to_one_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

Related linkage

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

builds-betaGroups-create_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

builds-betaGroups-delete_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

builds-individualTesters-get_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

builds-individualTesters-create_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

builds-individualTesters-delete_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

BundleIdCapabilities

bundleIdCapabilities-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

BundleIdCapability representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

bundleIdCapabilities-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

BundleIdCapability representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

bundleIdCapabilities-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

BundleIds

bundleIds-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[identifier]
Array of strings

filter by attribute 'identifier'

filter[name]
Array of strings

filter by attribute 'name'

filter[platform]
Array of strings
Items Enum: "IOS" "MAC_OS"

filter by attribute 'platform'

filter[seedId]
Array of strings

filter by attribute 'seedId'

filter[id]
Array of strings

filter by id(s)

sort
Array of strings
Items Enum: "id" "-id" "identifier" "-identifier" "name" "-name" "platform" "-platform" "seedId" "-seedId"

comma-separated list of sort expressions; resources will be sorted as specified

fields[bundleIds]
Array of strings
Items Enum: "app" "bundleIdCapabilities" "identifier" "name" "platform" "profiles" "seedId"

the fields to include for returned resources of type bundleIds

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Enum: "app" "bundleIdCapabilities" "profiles"

comma-separated list of relationships to include

fields[bundleIdCapabilities]
Array of strings
Items Enum: "bundleId" "capabilityType" "settings"

the fields to include for returned resources of type bundleIdCapabilities

fields[profiles]
Array of strings
Items Enum: "bundleId" "certificates" "createdDate" "devices" "expirationDate" "name" "platform" "profileContent" "profileState" "profileType" "uuid"

the fields to include for returned resources of type profiles

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[bundleIdCapabilities]
integer <= 50

maximum number of related bundleIdCapabilities returned (when they are included)

limit[profiles]
integer <= 50

maximum number of related profiles returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

bundleIds-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

BundleId representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

bundleIds-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[bundleIds]
Array of strings
Items Enum: "app" "bundleIdCapabilities" "identifier" "name" "platform" "profiles" "seedId"

the fields to include for returned resources of type bundleIds

include
Array of strings
Items Enum: "app" "bundleIdCapabilities" "profiles"

comma-separated list of relationships to include

fields[bundleIdCapabilities]
Array of strings
Items Enum: "bundleId" "capabilityType" "settings"

the fields to include for returned resources of type bundleIdCapabilities

fields[profiles]
Array of strings
Items Enum: "bundleId" "certificates" "createdDate" "devices" "expirationDate" "name" "platform" "profileContent" "profileState" "profileType" "uuid"

the fields to include for returned resources of type profiles

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[bundleIdCapabilities]
integer <= 50

maximum number of related bundleIdCapabilities returned (when they are included)

limit[profiles]
integer <= 50

maximum number of related profiles returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

bundleIds-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

BundleId representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

bundleIds-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

Certificates

certificates-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[certificateType]
Array of strings
Items Enum: "IOS_DEVELOPMENT" "IOS_DISTRIBUTION" "MAC_APP_DISTRIBUTION" "MAC_INSTALLER_DISTRIBUTION" "MAC_APP_DEVELOPMENT" "DEVELOPER_ID_KEXT" "DEVELOPER_ID_APPLICATION" "DEVELOPMENT" "DISTRIBUTION"

filter by attribute 'certificateType'

filter[displayName]
Array of strings

filter by attribute 'displayName'

filter[serialNumber]
Array of strings

filter by attribute 'serialNumber'

filter[id]
Array of strings

filter by id(s)

sort
Array of strings
Items Enum: "certificateType" "-certificateType" "displayName" "-displayName" "id" "-id" "serialNumber" "-serialNumber"

comma-separated list of sort expressions; resources will be sorted as specified

fields[certificates]
Array of strings
Items Enum: "certificateContent" "certificateType" "csrContent" "displayName" "expirationDate" "name" "platform" "serialNumber"

the fields to include for returned resources of type certificates

limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

certificates-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

Certificate representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

certificates-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[certificates]
Array of strings
Items Enum: "certificateContent" "certificateType" "csrContent" "displayName" "expirationDate" "name" "platform" "serialNumber"

the fields to include for returned resources of type certificates

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

certificates-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

Devices

devices-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[name]
Array of strings

filter by attribute 'name'

filter[platform]
Array of strings
Items Enum: "IOS" "MAC_OS"

filter by attribute 'platform'

filter[status]
Array of strings
Items Enum: "ENABLED" "DISABLED"

filter by attribute 'status'

filter[udid]
Array of strings

filter by attribute 'udid'

filter[id]
Array of strings

filter by id(s)

sort
Array of strings
Items Enum: "id" "-id" "name" "-name" "platform" "-platform" "status" "-status" "udid" "-udid"

comma-separated list of sort expressions; resources will be sorted as specified

fields[devices]
Array of strings
Items Enum: "addedDate" "deviceClass" "model" "name" "platform" "status" "udid"

the fields to include for returned resources of type devices

limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

devices-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

Device representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

devices-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[devices]
Array of strings
Items Enum: "addedDate" "deviceClass" "model" "name" "platform" "status" "udid"

the fields to include for returned resources of type devices

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

devices-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

Device representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

EndUserLicenseAgreements

endUserLicenseAgreements-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

EndUserLicenseAgreement representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

endUserLicenseAgreements-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[endUserLicenseAgreements]
Array of strings
Items Enum: "agreementText" "app" "territories"

the fields to include for returned resources of type endUserLicenseAgreements

include
Array of strings
Items Enum: "app" "territories"

comma-separated list of relationships to include

fields[territories]
Array of strings
Items Value: "currency"

the fields to include for returned resources of type territories

limit[territories]
integer <= 50

maximum number of related territories returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

endUserLicenseAgreements-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

EndUserLicenseAgreement representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

endUserLicenseAgreements-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

FinanceReports

financeReports-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[regionCode]
required
Array of strings

filter by attribute 'regionCode'

filter[reportDate]
required
Array of strings

filter by attribute 'reportDate'

filter[reportType]
required
Array of strings
Items Enum: "FINANCIAL" "FINANCE_DETAIL"

filter by attribute 'reportType'

filter[vendorNumber]
required
Array of strings

filter by attribute 'vendorNumber'

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

IdfaDeclarations

idfaDeclarations-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

IdfaDeclaration representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

idfaDeclarations-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

IdfaDeclaration representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

idfaDeclarations-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

InAppPurchases

inAppPurchases-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[inAppPurchases]
Array of strings
Items Enum: "apps" "inAppPurchaseType" "productId" "referenceName" "state"

the fields to include for returned resources of type inAppPurchases

include
Array of strings
Items Value: "apps"

comma-separated list of relationships to include

limit[apps]
integer <= 50

maximum number of related apps returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

PreReleaseVersions

preReleaseVersions-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[builds.expired]
Array of strings

filter by attribute 'builds.expired'

filter[builds.processingState]
Array of strings
Items Enum: "PROCESSING" "FAILED" "INVALID" "VALID"

filter by attribute 'builds.processingState'

filter[platform]
Array of strings
Items Enum: "IOS" "MAC_OS" "TV_OS"

filter by attribute 'platform'

filter[version]
Array of strings

filter by attribute 'version'

filter[app]
Array of strings

filter by id(s) of related 'app'

filter[builds]
Array of strings

filter by id(s) of related 'builds'

sort
Array of strings
Items Enum: "version" "-version"

comma-separated list of sort expressions; resources will be sorted as specified

fields[preReleaseVersions]
Array of strings
Items Enum: "app" "builds" "platform" "version"

the fields to include for returned resources of type preReleaseVersions

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Enum: "app" "builds"

comma-separated list of relationships to include

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[builds]
integer <= 50

maximum number of related builds returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

preReleaseVersions-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[preReleaseVersions]
Array of strings
Items Enum: "app" "builds" "platform" "version"

the fields to include for returned resources of type preReleaseVersions

include
Array of strings
Items Enum: "app" "builds"

comma-separated list of relationships to include

fields[builds]
Array of strings
Items Enum: "app" "appEncryptionDeclaration" "appStoreVersion" "betaAppReviewSubmission" "betaBuildLocalizations" "betaGroups" "buildBetaDetail" "diagnosticSignatures" "expirationDate" "expired" "iconAssetToken" "icons" "individualTesters" "minOsVersion" "perfPowerMetrics" "preReleaseVersion" "processingState" "uploadedDate" "usesNonExemptEncryption" "version"

the fields to include for returned resources of type builds

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[builds]
integer <= 50

maximum number of related builds returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

Profiles

profiles-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[name]
Array of strings

filter by attribute 'name'

filter[profileState]
Array of strings
Items Enum: "ACTIVE" "INVALID"

filter by attribute 'profileState'

filter[profileType]
Array of strings
Items Enum: "IOS_APP_DEVELOPMENT" "IOS_APP_STORE" "IOS_APP_ADHOC" "IOS_APP_INHOUSE" "MAC_APP_DEVELOPMENT" "MAC_APP_STORE" "MAC_APP_DIRECT" "TVOS_APP_DEVELOPMENT" "TVOS_APP_STORE" "TVOS_APP_ADHOC" "TVOS_APP_INHOUSE" "MAC_CATALYST_APP_DEVELOPMENT" "MAC_CATALYST_APP_STORE" "MAC_CATALYST_APP_DIRECT"

filter by attribute 'profileType'

filter[id]
Array of strings

filter by id(s)

sort
Array of strings
Items Enum: "id" "-id" "name" "-name" "profileState" "-profileState" "profileType" "-profileType"

comma-separated list of sort expressions; resources will be sorted as specified

fields[profiles]
Array of strings
Items Enum: "bundleId" "certificates" "createdDate" "devices" "expirationDate" "name" "platform" "profileContent" "profileState" "profileType" "uuid"

the fields to include for returned resources of type profiles

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Enum: "bundleId" "certificates" "devices"

comma-separated list of relationships to include

fields[certificates]
Array of strings
Items Enum: "certificateContent" "certificateType" "csrContent" "displayName" "expirationDate" "name" "platform" "serialNumber"

the fields to include for returned resources of type certificates

fields[devices]
Array of strings
Items Enum: "addedDate" "deviceClass" "model" "name" "platform" "status" "udid"

the fields to include for returned resources of type devices

fields[bundleIds]
Array of strings
Items Enum: "app" "bundleIdCapabilities" "identifier" "name" "platform" "profiles" "seedId"

the fields to include for returned resources of type bundleIds

limit[certificates]
integer <= 50

maximum number of related certificates returned (when they are included)

limit[devices]
integer <= 50

maximum number of related devices returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

profiles-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

Profile representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

profiles-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[profiles]
Array of strings
Items Enum: "bundleId" "certificates" "createdDate" "devices" "expirationDate" "name" "platform" "profileContent" "profileState" "profileType" "uuid"

the fields to include for returned resources of type profiles

include
Array of strings
Items Enum: "bundleId" "certificates" "devices"

comma-separated list of relationships to include

fields[certificates]
Array of strings
Items Enum: "certificateContent" "certificateType" "csrContent" "displayName" "expirationDate" "name" "platform" "serialNumber"

the fields to include for returned resources of type certificates

fields[devices]
Array of strings
Items Enum: "addedDate" "deviceClass" "model" "name" "platform" "status" "udid"

the fields to include for returned resources of type devices

fields[bundleIds]
Array of strings
Items Enum: "app" "bundleIdCapabilities" "identifier" "name" "platform" "profiles" "seedId"

the fields to include for returned resources of type bundleIds

limit[certificates]
integer <= 50

maximum number of related certificates returned (when they are included)

limit[devices]
integer <= 50

maximum number of related devices returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

profiles-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

RoutingAppCoverages

routingAppCoverages-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

RoutingAppCoverage representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

routingAppCoverages-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[routingAppCoverages]
Array of strings
Items Enum: "appStoreVersion" "assetDeliveryState" "fileName" "fileSize" "sourceFileChecksum" "uploadOperations" "uploaded"

the fields to include for returned resources of type routingAppCoverages

include
Array of strings
Items Value: "appStoreVersion"

comma-separated list of relationships to include

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

routingAppCoverages-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

RoutingAppCoverage representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "links":
    {
    }
}

routingAppCoverages-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

SalesReports

salesReports-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[frequency]
required
Array of strings
Items Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY"

filter by attribute 'frequency'

filter[reportDate]
Array of strings

filter by attribute 'reportDate'

filter[reportSubType]
required
Array of strings
Items Enum: "SUMMARY" "DETAILED" "OPT_IN"

filter by attribute 'reportSubType'

filter[reportType]
required
Array of strings
Items Enum: "SALES" "PRE_ORDER" "NEWSSTAND" "SUBSCRIPTION" "SUBSCRIPTION_EVENT" "SUBSCRIBER"

filter by attribute 'reportType'

filter[vendorNumber]
required
Array of strings

filter by attribute 'vendorNumber'

filter[version]
Array of strings

filter by attribute 'version'

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

Territories

territories-get_collection

Authorizations:
itc-bearer-token
query Parameters
fields[territories]
Array of strings
Items Value: "currency"

the fields to include for returned resources of type territories

limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

UserInvitations

userInvitations-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[email]
Array of strings

filter by attribute 'email'

filter[roles]
Array of strings
Items Enum: "ADMIN" "FINANCE" "TECHNICAL" "ACCOUNT_HOLDER" "READ_ONLY" "SALES" "MARKETING" "APP_MANAGER" "DEVELOPER" "ACCESS_TO_REPORTS" "CUSTOMER_SUPPORT"

filter by attribute 'roles'

filter[visibleApps]
Array of strings

filter by id(s) of related 'visibleApps'

sort
Array of strings
Items Enum: "email" "-email" "lastName" "-lastName"

comma-separated list of sort expressions; resources will be sorted as specified

fields[userInvitations]
Array of strings
Items Enum: "allAppsVisible" "email" "expirationDate" "firstName" "lastName" "provisioningAllowed" "roles" "visibleApps"

the fields to include for returned resources of type userInvitations

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Value: "visibleApps"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[visibleApps]
integer <= 50

maximum number of related visibleApps returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

userInvitations-create_instance

Authorizations:
itc-bearer-token
Request Body schema: application/json

UserInvitation representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

userInvitations-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[userInvitations]
Array of strings
Items Enum: "allAppsVisible" "email" "expirationDate" "firstName" "lastName" "provisioningAllowed" "roles" "visibleApps"

the fields to include for returned resources of type userInvitations

include
Array of strings
Items Value: "visibleApps"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[visibleApps]
integer <= 50

maximum number of related visibleApps returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

userInvitations-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

Users

users-get_collection

Authorizations:
itc-bearer-token
query Parameters
filter[roles]
Array of strings
Items Enum: "ADMIN" "FINANCE" "TECHNICAL" "ACCOUNT_HOLDER" "READ_ONLY" "SALES" "MARKETING" "APP_MANAGER" "DEVELOPER" "ACCESS_TO_REPORTS" "CUSTOMER_SUPPORT"

filter by attribute 'roles'

filter[username]
Array of strings

filter by attribute 'username'

filter[visibleApps]
Array of strings

filter by id(s) of related 'visibleApps'

sort
Array of strings
Items Enum: "lastName" "-lastName" "username" "-username"

comma-separated list of sort expressions; resources will be sorted as specified

fields[users]
Array of strings
Items Enum: "allAppsVisible" "firstName" "lastName" "provisioningAllowed" "roles" "username" "visibleApps"

the fields to include for returned resources of type users

limit
integer <= 200

maximum resources per page

include
Array of strings
Items Value: "visibleApps"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[visibleApps]
integer <= 50

maximum number of related visibleApps returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

users-get_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
fields[users]
Array of strings
Items Enum: "allAppsVisible" "firstName" "lastName" "provisioningAllowed" "roles" "username" "visibleApps"

the fields to include for returned resources of type users

include
Array of strings
Items Value: "visibleApps"

comma-separated list of relationships to include

fields[apps]
Array of strings
Items Enum: "appInfos" "appStoreVersions" "availableInNewTerritories" "availableTerritories" "betaAppLocalizations" "betaAppReviewDetail" "betaGroups" "betaLicenseAgreement" "betaTesters" "builds" "bundleId" "contentRightsDeclaration" "endUserLicenseAgreement" "gameCenterEnabledVersions" "inAppPurchases" "isOrEverWasMadeForKids" "name" "perfPowerMetrics" "preOrder" "preReleaseVersions" "prices" "primaryLocale" "sku"

the fields to include for returned resources of type apps

limit[visibleApps]
integer <= 50

maximum number of related visibleApps returned (when they are included)

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

users-update_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

User representation

required
object

Responses

Request samples

Content type
application/json
{
  • "data":
    {
    }
}

Response samples

Content type
application/json
{
  • "data":
    {
    },
  • "included":
    [
    ],
  • "links":
    {
    }
}

users-delete_instance

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Responses

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

users-visibleApps-get_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

users-visibleApps-create_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

users-visibleApps-replace_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

users-visibleApps-delete_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

DiagnosticSignatures

GameCenterEnabledVersions

gameCenterEnabledVersions-compatibleVersions-get_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

query Parameters
limit
integer <= 200

maximum resources per page

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "links":
    {
    },
  • "meta":
    {
    }
}

gameCenterEnabledVersions-compatibleVersions-create_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

gameCenterEnabledVersions-compatibleVersions-replace_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}

gameCenterEnabledVersions-compatibleVersions-delete_to_many_relationship

Authorizations:
itc-bearer-token
path Parameters
id
required
string

the id of the requested resource

Request Body schema: application/json

List of related linkages

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json
{
  • "errors":
    [
    ]
}